ProductSearch Server Control

with all of the words

advanced search exact phrase

at least one of the words

Price Below

Price Above

edescription

Searches only the description of a product for the matching text.

The description of a product is set in the Content tab’s editor for a product in the Workarea. See Also: Step 2: Creating the Content Page

@edescription chair

eheight

Searches based on the height of a product.

The height of a product is set on the product’s Properties tab in the Workarea. See Also: Entering a Catalog Entry’s Properties

@eheight = 40

@eheight > 40

@eheight < 40

eimage

Searches based on an image name associated with a product; for example, chair.jpg.

Images are associated with a product when they are added to a product’s Media tab in the Workarea. See Also: Entering a Catalog Entry’s Media

@eimage chair.jpg

elength

Searches based on the length of a product.

The length of a product is set on the product’s Properties tab in the Workarea. See Also: Entering a Catalog Entry’s Properties”

@elength = 15

@elength > 15

@elength < 15

elistprice

Searches based on the list price of the product.

The list price for a product is set on the product’s Pricing tab in the Workarea. See Also: Entering a Catalog Entry’s Price Information

@elistprice = 299.00

@elistprice > 299.00

@elistprice < 299.00

ereorderlevel

Searches for a product based on its reorder level.

The reorder level for a product is set on the product’s Properties tab in the Workarea. See Also: Entering a Catalog Entry’s Properties

@ereorderlevel = 125

@ereorderlevel > 125

@ereorderlevel < 125

esaleprice

Searches based on the sale price of the product.

The sale price for a product is set on the product’s Pricing tab in the Workarea.See Also: Entering a Catalog Entry’s Price Information

@esaleprice = 249.00

@esaleprice > 249.00

@esaleprice < 249.00

eskunumber

Searches based on the Stock Keeping Unit for product.

This information is set on the product’s Properties tab in the Workarea. See Also: Entering a Catalog Entry’s Properties”

@eskunumber 52-154

eunitsinstock

Searches for a product based on its level of units in stock.

The units in stock for a product is set on the product’s Properties tab in the Workarea. See Also: Entering a Catalog Entry’s Properties

@eunitsinstock = 63

@eunitsinstock > 63

@eunitsinstock < 63

eunitsonorder

Searches for a product based on the amount of units on order.

The amount of units on order for a product is set on the item’s Properties tab in the Workarea. See Also: Entering a Catalog Entry’s Properties

@eunitsonorder = 30

@eunitsonorder > 30

@eunitsonorder < 30

eweight

Searches based on the weight of a product.

The weight of a product is set on the product’s Properties tab in the Workarea.See Also: Entering a Catalog Entry’s Properties”

@eweight = 45

@eweight > 45

@eweight < 45

Authenticated

Indicates if you are logged in to the CMS Explorer
and can use it to browse to Content, Collections, etc. See Also: Working with Ektron CMS400.NET Server Controls

ButtonImgSrc

If you want to display an image on the Submit button, enter the server path to it.

ButtonText

The text used for the Submit button if no image source is identified. If an image source is identified, this is alternative text for the button.

CatalogId

The catalog at which the search begins. The starting folder need not be the root folder.

The Recursive property determines if the search examines this folder’s subfolders. See Also: Working with Ektron CMS400.NET Server Controls

CustomOrderBy

Provide a property’s Friendly Name defined in the Indexing Service to sort search results by that property.

Results can be ascending or descending based on OrderDirection. If you enter an invalid property, no search results are returned.

If you specify CustomOrderBy and OrderBy, the OrderBy property is ignored. The Friendly Name of a property can be found in Computer Management > Services and Applications > Indexing Service > Your Index > Properties > Friendly Name column.

CustomXml

(Code Behind Only)

Provides a mechanism to inject custom XML into the generated XML before being processed by the XSLT. The injected XML is appended to the end of the XML produced by this control. See Also:

Displaying Custom XML in Ektron’s Server Controls

DisplayXslt

Specify an external XSLT file to render the control. By default, the control uses ProductSearch.xsl. This file is located in
<SiteRoot>\Workarea\Xslt\Commerce

Important: If you want to edit this file, it is strongly recommended that you make a copy, change its name and move it outside your site’s Workarea folder. If you make changes to this file and do not move it out of the Workarea folder, this file and the changes will be lost when you upgrade.

DoInitFill

By default, Fill occurs during the Page_Init event. Set to false if you want to postpone the fill-action until later. In this case, FIll is automatically called during the Page Render event.

You might do this if you need to set or change a property on the control in codebehind and have it render with your changes shown.

DynamicProductParameter

The QueryString parameter name which is used to pass the product ID to the product details page. For example, if your QueryString parameter for products is ID, enter that in this property. Then, when site visitors click a product in their search results, this parameter is passed with the product’s ID to the product details page.

EnableAdvancedLink

Set to True to display an Advanced Search tab on the ProductSearch control.

Hide

Used to hide ProductSearch Server Control in design time and runtime.

True = Hide control

False = Show control

Language

If the template on which this server control resides includes a language selection control, and you want to let the site visitor select the language, enter zero (0).

Otherwise, click the field, then ellipsis () and a popup box appears. Select a language from the list.

This property shows results in design-time (in Visual Studio) and at run-time (in a browser).

LinkTarget

Defines how a link on the search results display acts when clicked. The choices are:

_blank - loads the link in a new blank window. This window is not named.

_self - loads the link in the same window the anchor was clicked in. This is useful for overriding a globally assigned base target.

_parent - loads the link in the immediate frameset parent of the document. This defaults to acting like “_self” if the document has no parent.

_top - loads the link in the full body of the window. This defaults to acting like “_self” if the document is already at the top. It is useful for breaking out of an arbitrarily deep frame nesting.

LoadingImage

The image to display while the product search is loading.

The default is ajaxloader_circle_lg.gif.

This file is located in: <siteroot>
\Workarea\images\application

MaxCharacters

The maximum number of characters the Search text box accepts.

If you enter a value less than 50, set the TextBoxSize property to the same number.

MaxTeaserLength

Limits the length of any returned content’s abstract. To allow unlimited length, set to zero.

This property is active only if both of these conditions are true.

You use the DisplayXslt property to identify an XSLT and ecmteaser as a value of that property.

the ShowCustomSummary property is set to false. If ShowCustomSummary is set to true, the entire summary appears in search results.

OrderBy

The order of search results. For example, you want to sort search results by last modified date.

Note: The Order Direction field determines the direction of the search results. For example, if you sort by ID and OrderDirection is set to Descending, the results sort by ContentID number with the highest number at the top of the list.

OrderDirection

The direction in which search results are sorted. The default is Ascending.

Ascending - Alphabetical results from A to Z; numeric values low to high; dates from oldest to most recent

Descending - Alphabetical results from Z to A; numeric values high to low; dates from most recent to oldest

Recursive

Set to True to search sub-folders of the starting folder. The starting folder is identified in the CatalogID property.

ResultsPageSize

Set the maximum number of results on a page. If a search returns more than this number of results, the following text appears below the last one:

Result Page: 1 2 3 Next

The site visitor can click Next or a number to view additional results.

This property defaults to the value set at the ek_PageSize element in the web.config file.

ResultTagId

Lets you designate where search results appear. You can place search criteria in one area of a Web form and the results in another.

For example, you have the following tag.

<span id=”results”></span>

In this case, enter results for this property value.

Additional information can be found in the WebSearch server control section ResultTagId.

ShowCategories

If set to true, when this server control appears, the site visitor see a Filter by Category option. This option helps a site visitor zero in on relevant content.

If false, the Filter by Category option does not appear.

Note: To see the Filter by Category option, the ShowSearchBoxAlways property must be set to true.

See Also: Filtering Search Results by Category

ShowCustomSummary

If set to true, the search results display the content item’s summary instead of the characterization.

Note: If this property is set to true, the MaxTeaserLength property is ignored. So, the entire summary appears with search results, regardless of length.

If false, the search results display the characterization.

The default is false.

See Also: Display of Search Results

ShowSearchBoxAlways

If set to true, the search box appears on the PostBack screen.

If false, the search box does not appear on the PostBack screen.

The default is true.

Stylesheet

Specify the location of a style sheet to use for the search results page. Set the location relative to the site root folder. For example: Workarea\csslib\mytest.css

SuppressWrapperTags

Suppresses the output of span/div tags around the control. The default is False.

True - Suppress wrap tags.

False - Allow wrap tags.

TaxonomyOperator

Select whether to use an And or Or operator when filtering results by taxonomy. By default, the property is set to Or. This allows for a wider range of returned results.

And - Only results that match all categories selected in the Filter by Category tree appear. For example, if you are searching for a medical document in the Hospital and Doctor’s Office categories, the document must be assigned to both categories or it is not shown.

Or - when more than one category is selected in the Filter by Category tree, results must match at least one category to be shown.

Note: For this property to be active, the ShowCategories property must be set to True.

See Also: Filtering Search Results by Category

TemplateCart

Controls whether the Add to Cart link appears with search results. Enter the URL path of the template that contains the Cart server control. This path can be relative or absolute.

See Also: The Add to Cart Link in a Search Result and Cart Server Control.

TemplateProduct

Specify the URL that contains the Product server control. This allows a site visitor to see the details of the product when the product link is clicked. This path can be relative or absolute.